Deletes a file ID reference.

OSErr PBDeleteFileIDRefSync (
    HParmBlkPtr paramBlock
);

paramBlock

A pointer to an fidParam variant of the HFS parameter block.

function result

A result code.

DISCUSSION

The relevant fields of the parameter block are:

• ioCompletion

  On input, a pointer to a completion function.

• ioResult

  On output, the result code of the function.

• ioNamePtr

  On input, a pointer to a pathname.

• ioVRefNum

  On input, a volume specification.

• ioFileID

  On input, a file ID.

The PBDeleteFileIDRefSync function invalidates the specified file ID reference on the volume specified by ioVRefNum or ioNamePtr. After it has invalidated a file ID reference, the File Manager can no longer resolve that ID reference to a filename and parent directory ID.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)